/*
 * Copyright (c) 2008 VMware, Inc.
 * Copyright (c) 2009 John Pritchard, WTKX Project Group
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package wtkx.co;

import java.util.Comparator;

/**
 * Set listener interface.
 *
 * @author gbrown
 */
public interface SetListener<E> {
    /**
     * Called when an element is added to a set.
     *
     * @param set
     * The source of the set event.
     *
     * @param element
     * The element that was added to the set.
     */
    public void elementAdded(Set<E> set, E element);

    /**
     * Called when an element is removed from the set.
     *
     * @param set
     * The source of the set event.
     *
     * @param element
     * The element that was removed from the set.
     */
    public void elementRemoved(Set<E> set, E element);

    /**
     * Called when set data has been reset.
     *
     * @param set
     * The source of the set event.
     */
    public void setCleared(Set<E> set);

    /**
     * Called when a set's comparator has changed.
     *
     * @param set
     * The source of the event.
     *
     * @param previousComparator
     * The previous comparator value.
     */
    public void comparatorChanged(Set<E> set, Comparator<E> previousComparator);
}
